Skip to main content

refazer_consulta

Request

Pensando em facilitar o processo, caso o cliente queira fazer uma nova consulta com novas datas base à alguem que já fora previamente consultado, oferecemos a operação /scr/redo. A vantagem de utilizar esta operação é que, caso o documento de autorização para aquela pessoa ainda esteja válido, não haverá a criação de um novo documento para assinatura¹ e a consulta será criada imediatamente. O formato de assinatura do header e do body desta requisição é descrito em detalhes aqui.

  • ENDPOINT
    /scr/redo
  • MÉTODO
    POST
body.json
{
"report_start_date": "2019-02",
"report_end_date": "2020-03",
"origin_key": "bf6b5e8b-93df-4443-b1fc-d760db6ea4ff"
}

BODY PARAMS

CampoTipoDescrição
report_start_dateenumData de início da consulta (formato "AAAA-MM").
report_end_datestringData final da consulta (formato "AAAA-MM").
origin_keystringChave do SCR original (SRC_KEY) que será utilizada para refazer a consulta.

Response

status:

200

Response Body
{
"consent_term":"https://urldasassinaturas.com/assinaturas.zip",
"consulted_at":"2020-05-08",
"created_at":"2020-05-08",
"origin_key":"353b7aea-0bc5-4981-8015-16f7ba4252d4",
"report_end_date":"2020-03",
"report_start_date":"2019-02",
"result_document":"https://urldodocumento.com/documento_consulta.pdf",
"scr_key":"10b3feb4-6afa-425b-8537-99c2aa7afd74",
"scr_status":"consulted",
"signers":[
{
"document_number":"41184562067",
"email":"joao.ninguem@yopmail.com",
"name":"Joao Ninguem"
}
],
"subject_document_number":"41184562067",
"subject_name":"Joao Ninguem",
"subject_person_type":"natural"
}

status:

400

body.json
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}